home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / pcbfre2b.zip / PCBFRE.DOC < prev    next >
Text File  |  1991-10-09  |  19KB  |  435 lines
  1.  
  2.  
  3.  
  4.  
  5.                                    PCBFRE
  6.  
  7.                PCBoard Real-Time/Dynamic File Ratio Enforcer
  8.  
  9.  
  10.                      A PCBoard Post/Call Ratio Enforcer
  11.                        Files Upload/Download Enforcer
  12.                          File Bytes Ratio Enforcer
  13.  
  14.  
  15.                          Version 2.0, ??-December?-91?
  16.  
  17.                                 PCBFRE20.ZIP
  18.  
  19.                     For use with PCBoard Versions 14.5x
  20.  
  21.  
  22.  
  23.  
  24.                       Copyright (C) 1991 Geoffrey Sy;
  25.                             ALL RIGHTS RESERVED
  26.  
  27.  
  28.  
  29.          See PCBFRE.NEW for a listing of changes since version 1.0.
  30.  
  31.  
  32.  
  33.                        This program is supported by:
  34.  
  35.  
  36.                                 Geoffrey Sy
  37.                                51 Wyatt Walk
  38.                           Toronto, Ontario  Canada
  39.                                   M5A 3T3
  40.  
  41.  
  42.                                 Support BBS:
  43.  
  44.                            The GRAFIX Connection
  45.                       (416) 286-8734 1200/2400 ATi/etc
  46.                      (416) 287-9002 9600/14400 USR HST
  47.  
  48.  
  49.                                    - 2 -
  50.  
  51.  
  52.                             TABLE OF CONTENTS 
  53.                             =================
  54.  
  55.  
  56. Introduction ........................................................ 3
  57.  
  58. Installation ........................................................ 3     
  59.      Editing PCBoard's PWRD ......................................... 3     
  60.      Editing PCBFRE's Configuration/Program Manager ................. 3     
  61.      Editing PCBoard's Door Security File ........................... 3     
  62.      Editing PCBFRE Door Script file ................................ 4     
  63.      Trial Run ...................................................... 4     
  64.      Editing PCBFRE's Display Files ................................. 5
  65.      PCBFRE Display Files Substitution Variables .................... 5
  66.  
  67.  
  68. Program Capabilities ................................................ 6
  69.      Security/Language specific display files ....................... 6     
  70.      Non-Standard COM Ports ......................................... 6     
  71.      Session Logging ................................................ 6     
  72.      Multi-Tasking/Node Support ..................................... 6     
  73.      Network, File Sharing Support .................................. 6     
  74.      SysOp Function Keys ............................................ 7
  75.  
  76. Error Codes ......................................................... 8
  77.      Bug Report Procedure ........................................... 8
  78.  
  79. Support/Registrations................................................ 9
  80.  
  81. Disclaimers/Copyrights .............................................. 9
  82.  
  83.  
  84.                                    - 3 -
  85.  
  86.  
  87.                                INTRODUCTION
  88.                                ============
  89.  
  90. This program was written because of SysOps complaints of PCBoard's lack of
  91. ratio enforcement.  PCBFRE is a utility door for PCBoard 14.5x to calculate
  92. user download bytes based on their download/upload and post/call ratio.
  93.  
  94.  
  95.                       PROGRAM INSTALLATION/OPERATION
  96.                       ==============================
  97.  
  98. Step #1:
  99. =======
  100.  
  101. Edit PCBoard's PWRD file and set daily download bytes to 0 for the security
  102. levels affected by this program.
  103.  
  104. Step #2:
  105. ========
  106.  
  107. Edit PCBFRE's configuration file.  The one included in this archive is called
  108. PCBFRE.CNF.  Please use FRESM to edit this file.  The command line for
  109. starting FRESM is: FRESM PCBFRE.CNF C:\PCB
  110.                                 │        │
  111.                                 │       PCBoard System directory
  112.                           Name of CNF file
  113.  
  114. Just follow the menus and you shouldn't have any problem.
  115.  
  116. If you want to know the items in the configuration file, they are formatted
  117. below:
  118.  
  119. INTERRUPT  <= Line 1: Comm driver routine INTERRUPT or BIOS whatever works
  120. Your BOARD <= Line 2: Your BBS Name
  121. 0          <= Line 3: Registration number (0 if unregistered)
  122. PCBFRE.DP  <= Line 4: Display file for normal users and exceeding bytes
  123. FILES      <= Line 5: Display file for users exceeded their files limit
  124. MSGS       <= Line 6: Display file for users exceeded post/call ratio
  125. EXEMPT     <= Line 7: Display file for users not enforced by PCBFRE
  126. WELCOME    <= Line 8: Welcome screen for FREBANK ─┐
  127. GOODBYE    <= Line 9: Goodbye screen for FREBANK  │ Not yet implemted
  128. HELP       <= Line 10: Help file for FREBANK      │ as of 09/21/91
  129. MENU       <= Line 11: Menu file for FREBANK      ┘
  130. 100 10.25 15.75 10.5 999999999
  131.  │    │     │    │      └─ Maximum daily download bytes limit
  132.  │    │     │    └──────── # of calls allowed per message posted
  133.  │    │     └───────────── # of files download per 1 file upload.
  134.  │    └─────────────────── # of download Kbytes per 1 upload Kbyte.
  135.  └──────────────────────── Security Level
  136.  
  137.     The above example would allow this users with security level 100 to     
  138.     download 10.25 Kbytes for every 1 Kbyte they uploaded not exceeding     
  139.     15.75 files for each file they uploaded and must post 1 message every   
  140.     10.5 calls. Can only download a maximum of 1 GigaByte per session.
  141.                                    -4-
  142.  
  143.  
  144.     You can have as many security level and ratio as you want, just place   
  145.     them below line 6 - one security level per line. The file and byte and  
  146.     post/call ratio value is limited to 3 digits and 2 decimal places. The  
  147.     security level is limited to 3 digits.  If you don't want to enforce    
  148.     bytes, files or post/call ratio, put a zero (0) in the appropriate      
  149.     field(s).
  150.  
  151. Step #3:
  152. ========
  153.  
  154. Setup PCBFRE as a PCBoard Door.  Load up PCBSetup, go to edit door security
  155. file and add the following line:
  156.  
  157.                                      USER DOOR
  158.     Filename    Password   Sec Login SYS  SYS  Shell Path to DOOR Files   
  159. ══════════ ════════════ ═══ ═════ ════ ════ ═════ ═══════════════════     
  160. PCBFRE                  0   Y    Y    N     Y                               
  161.  
  162. The Autologin and Shell option is optional.  PCBFRE requires about 128K to
  163. operate.  Make sure you have enough memory if you want PCBoard to shell to
  164. PCBFRE.  The USERS.SYS option must be set to Y or PCBFRE won't work!  You may
  165. now edit the PCBFRE door script.  Call up the text editor and create a file
  166. with the following item (this file is included in this package):
  167.  
  168.      @ECHO OFF
  169.      REM PCBoard door script for PCBFRE - PCBoard File Ratio Enforcer.      
  170.      %PCBDRIVE%
  171.      CD \PCB\FRE
  172.  
  173. The above is your typical door script file.  The command line for PCBFRE is
  174. explained below:
  175.  
  176.      PCBFRE PCBFRE.CNF C:\PCB  /POSTDL
  177.               │          │        │
  178.               │          │      Enforce post/download instead of post/call
  179.               │        Location of your PCBoard Node directory
  180.          PCBFRE's configuration
  181.  
  182. That's all that's needed.  The line below "IF (%INPCB%)==(Y) EXIT" is used to
  183. exit from shelled doors.  If you don't run PCBFRE as a shelled door then you
  184. may remove it.
  185.  
  186.      CD %PCBDIR%
  187.      IF (%INPCB%)==(Y) EXIT
  188.      BOARD
  189.  
  190.  
  191. Step #4:
  192. ========
  193.  
  194. TRIAL RUN.  If you have a runtime error please check the runtime error codes
  195. in this document.                   -5-
  196.  
  197. Step #5:
  198. ========
  199.  
  200. Cosmetics:  The external display files called 'PCBFRE', 'FILES', 'MSGS' and
  201. other may be edited to your taste. Press F2 to edit the non-colored version
  202. and F3 to edit the ANSI version from FRESM.  Feel free to customize these
  203. files to match the theme of your BBS.   All ASCII, ANSI and IBM graphics
  204. characters are supported in the display files.  You can use all PCBoard's
  205. @X## colour codes as well as the following variables:
  206.  
  207.       @MSGRATIO@           SysOp set # of calls allowed per message posted
  208.       @FILERATIO@          SysOp set # of files download per file uploaded
  209.       @BYTERATIO@          SysOp set # of bytes download per byte uploaded
  210.       @ADJBYTES@           Adjusted download bytes available
  211.       @MSGLEFT@            Messages user has left/uploaded to PCBoard
  212.       @MSGREAD@            Message user has read/downloaded from PCBoard
  213.  
  214.       $B$                  modem open baud rate
  215.       $C$                  connect bps same as @BPS@
  216.       $CLREOL$             clear to end of line
  217.       $DEFAULT$            the default color
  218.       $FIRST$              callers first name
  219.       $N$                  port number 0=local, 1..4
  220.       $NAME$               callers full name same as @USER@
  221.       $NODE$               current node number
  222.       $NONSTOP$            display the rest of the file non-stop
  223.       $SYSOP$              sysop name
  224.       $TIME$               daily time limit in minutes
  225.       @BEEP@               beep speaker, control-g
  226.       @BOARDNAME@          the name of your BBS
  227.       @BPS@                estimated connect bps
  228.       @CITY@               city and state of caller (all caps)
  229.       @CLS@                clear screen
  230.       @DATAPHONE@          caller's business/data phone number
  231.       @DLBYTES@            total bytes downloaded - all calls
  232.       @DLFILES@            total files downloaded - all calls
  233.       @EVENT@              time of next scheduled event                     
  234.       @EXPDATE@            subscription expiration date
  235.       @FIRST@              first name of the user (first letter capitalized) 
  236.       @HOMEPHONE@          caller voice phone number
  237.       @LASTDATEON@         last date on (mm-dd-yy format)
  238.       @LASTTIMEON@         last time on (hh:mm format)
  239.       @MORE@               force a "MORE" prompt
  240.       @NUMTIMESON@         number of times on system
  241.       @SECURITY@           users current security level including conf. add. 
  242.       @SYSDATE@            host date in (mm-dd-yy format)
  243.       @SYSTIME@            host system in (hh:mm format)
  244.       @TIMELEFT@           time remaining that call incl. all credits, etc. 
  245.       @TIMELIMIT@          time allowed from PWRD file
  246.       @TIMEUSED@           minutes used since logon
  247.       @UPBYTES@            total bytes uploaded - all calls
  248.       @UPFILES@            total files uploaded - all calls
  249.       @USER@               complete name of the caller (first & last in caps) 
  250.       @WAIT@               force a "press enter to continue" prompt -6-
  251.  
  252.  
  253.                             PROGRAM CAPABILITIES
  254.                             ====================
  255.  
  256. PCBFRE is a standard ProKit door.  Some of its features include:
  257.  
  258.      +    Security-level / Language specfic display files:
  259.  
  260.           All that's required is to replace the first 3 letters of the menu 
  261.           name with the security level.
  262.  
  263.                     For level 60,  NORMAL becomes 060MAL
  264.  
  265.           For language specfic menu, let say French just add the extension  
  266.           as specified in PCBoard.
  267.  
  268.                 For French (.FRE), NORMAL becomes NORMAL.FRE
  269.                 Add level specfic and it becomes  060MAL.FRE
  270.  
  271.      +    Support for non-standard COM ports COM3 - COM8.  If the door      
  272.           doesn't work with your COM port you may set the following
  273.           environment variables:
  274.  
  275.                               SET COMBASE=nnnn
  276.           Sets the base I/O address (in DECIMAL) for non-standard COM       
  277.           ports.
  278.  
  279.                                 SET COMIRQ=n
  280.           Sets the IRQ level for non-standard COM ports.
  281.  
  282.      +    Multi-Nodes are Supported
  283.  
  284.      +    Baud Rates up to 115200 bps are suppored
  285.  
  286.      +    Complete session logging. Everything the user sees can be
  287.           captured in a session log.  This is enabled by adding
  288.                      SET PRODEBUG=ON
  289.           to the door script; output will be logged to DEBUG.OUT.
  290.  
  291.      +    Operation under DoubleDOS, TaskView or DesqView is fully
  292.           supported. The door will give up idle time to speed the other     
  293.           partition. If screen bleedthrough or background lockups occur,    
  294.           you may need to add the environment statement
  295.                      SET OVCRT=ON
  296.           before executing the door.
  297.  
  298.      +    Automatic network file sharing is implemented on all system       
  299.           files. The door has been tested under LanTastic, Novell, NTNX and 
  300.           other true networks.      -7-
  301.  
  302.  
  303.      +    Sysop function keys are supported:
  304.               F2  . . . Lockout current user
  305.               F3  . . . Toggle printer logging
  306.               F4  . . . Toggle operator page bell
  307.               F5  . . . Shell to DOS while caller is online
  308.               F7  . . . Toggle alarm beeps
  309.               F8  . . . Force immediate logoff and hangup
  310.               F9  . . . Toggle local display
  311.               F10 . . . Chat with user
  312.               ALT-B . . Debug/display memory and overlay information        
  313.               ALT-I . . File input during message entry and CHAT
  314.               ALT-F . . File capture of all displays
  315.               ALT-M . . Node status display
  316.               ALT-N . . Sysop on-next
  317.               ALT-P . . Print complete session
  318.               ALT-X . . Sysop dos-exit next
  319.               UP  . . .   Increase online time
  320.               DOWN  . . Decrease online time
  321.               PgUp  . . Display comments from user file
  322.               PgDn  . . Display phone numbers, expiration and password      
  323.               HOME  . . Sysop help message, listing available functions     
  324.               SHIFT . . F1..F10 . Sysop macro keys defined in PCBSETUP
  325.  
  326.  
  327.  
  328.                                 ERROR CODES
  329.                                 ===========
  330.  
  331.          Error    Class     Description
  332.  
  333.             2     DOS:       File not found  (Check command line)
  334.             3     DOS:       Path not found
  335.             4     DOS:       Too many open files (Check CONFIG.SYS)
  336.             5     DOS:       File access denied
  337.             6     DOS:       Bad file handle
  338.            12     DOS:       Bad file access code
  339.            16     DOS:       Can't remove current dir
  340.            15     DOS:       Bad drive number
  341.           100     I/O:       Disk read error
  342.           101     I/O:       Disk write error
  343.           102     I/O:       File not assigned
  344.           103     I/O:       File not open
  345.           104     I/O:       File not open for input
  346.           105     I/O:       File not open for output
  347.           106     I/O:       Bad numeric format (Check numbers in .CNF)     
  348.           150     CRITICAL:  Disk is write-protected
  349.           151     CRITICAL:  Unknown unit
  350.           152     CRITICAL:  Drive not ready
  351.           153     CRITICAL:  Unknown command
  352.           154     CRITICAL:  CRC error in data
  353.           156     CRITICAL:  Disk seek error -8-
  354.  
  355.           157     CRITICAL:  Unknown media type
  356.           158     CRITICAL:  Sector not found
  357.           159     CRITICAL:  Printer out of paper
  358.           160     CRITICAL:  Device write fault
  359.           161     CRITICAL:  Device read fault
  360.           162     CRITICAL:  Network or Hardware failure
  361.           200     FATAL:     Division by zero
  362.           201     FATAL:     Range check
  363.           202     FATAL:     Stack overflow
  364.           203     FATAL:     Heap overflow
  365.           204     FATAL:     Bad pointer operation
  366.           205     FATAL:     Floating point overflow
  367.           206     FATAL:     Floating point underflow
  368.           207     FATAL:     Bad floating point operation
  369.           208     FATAL:     Overlay Manager not initialized
  370.  
  371.  
  372.  
  373.  
  374.                                 BUG REPORTS
  375.                                 ===========
  376.  
  377. If you need to report a problem, please capture the session using DOS
  378. environment variable "SET PRODEBUG=ON".  The ouput file called "DEBUG.OUT"
  379. will be in the same directory that PCBFRE is executed from.  Depending on the
  380. node, the file will be named "DEBUG#.OUT" where # is the node number.  Please
  381. include this file as well as the USERS.SYS file in use during that session
  382. and a thorough explanation of the problem encountered. Please ZIP these files
  383. up and send it to my support BBS.   -9-
  384.  
  385.  
  386.                                   SUPPORT
  387.                                   =======
  388.  
  389. If you have any questions, bugs, or suggestions, please contact me.  I may be
  390. reached on the NaNET IBM, ProDOOR echo, Intelec(tm), City2City(tm), Rime, and
  391. other PCBoard echoes.  Or by mail to the above address or on my support BBS
  392. listed above.  Registered users may contact me using the voice number in the
  393. registration document.
  394.  
  395. Since this is user supported software, I don't expect you to register if you
  396. don't like it or if it doesn't meet your needs.  Just stop using it after a
  397. reasonable trial period (2-3 weeks). The program is not crippled in any way,
  398. there is only a short delay at the start/exit of the program to remind the
  399. user that the copy is un-registered.  I've had to do this because I've seen
  400. users use my program and never bothered to echo me a comment on the program.
  401. I like to get feedbacks, doesn't matter if they're good or bad. If you like
  402. the program and use it regularly, please register it.  Registration only
  403. costs $15.00 and you'll receive unlimited voice support and upgrades. Please
  404. mail your registration to the above address.
  405.  
  406. When you register, I will personally upload a registered copy and your
  407. registration information to your BBS.  The registration information will
  408. register all future versions of PCBFRE for you.  If you are not in the local
  409. 416 calling area then please add the appropriate amount to cover mailing and
  410. disk or long distance charges.  If you don't want the disk or me to upload
  411. the program, then don't add anything - your registration number will be sent
  412. by first class mail. Future copies downloaded from bulletins boards will work
  413. as registered copies when branded with your registration number.
  414.  
  415. If you plan to drop by my home to pick up the registration, please let me
  416. know in advance. I live in a rough neighborhood, so watch yourself if you
  417. really must pick up the registration in person. A few has dropped by so far
  418. and and have escaped safely with their registration.
  419.  
  420.  
  421.  
  422.                       STANDARD DISCLAIMERS/COPYRIGHTS
  423.                       ===============================
  424.  
  425. This program is provided on an "AS IS" basis.  No warranty of any kind is
  426. expressed or implied.  YOU USE THIS PROGRAM AT YOUR OWN RISK.  I take no
  427. responsibility for any damage caused directly or indirectly from the use or
  428. the inability to use this program.
  429.  
  430.  
  431. ProKit & Pro* Utilities - Copyrighted: Samuel H. Smith - The Tool Shop
  432. PCBoard                 - Copyrighted: Clarke Development Company
  433. Other                   - Copyrighted: Respected Owners
  434.  
  435.